i/5692: Added documentation for the config.toolbar.shouldNotGroupWhenFull option #201
Conversation
src/editor/editorconfig.jsdoc
Outdated
| @@ -162,6 +164,11 @@ | |||
| * * **`toolbar.viewportTopOffset`** – The offset (in pixels) from the top of the viewport used when positioning a sticky toolbar. | |||
| * Useful when a page with which the editor is being integrated has some other sticky or fixed elements | |||
| * (e.g. the top menu). Thanks to setting the toolbar offset the toolbar will not be positioned underneath or above the page's UI. | |||
| * * **`toolbar.shouldGroupWhenFull`** – When `true` (default), the toolbar will group its items that | |||
There was a problem hiding this comment.
This documentation entry is growing (items, viewportTopOffset and now shouldGroupWhenFull). I know it's convenient for developers to keep it in a single place (module:core/editor/editorconfig~EditorConfig#toolbar) but if we get more options like this, I think it's time to define some @interface ToolbarConfig and put the detailed documentation there.
There was a problem hiding this comment.
As long as those options are fairly simple (boolean, number, simple array), I'd keep them locally here because, as you mentioned, that more convenient to read. But I agree that at some point we may need to extract it. But then we can keep a lot of information here locally, and have details in the interface.
src/editor/editorconfig.jsdoc
Outdated
| * viewportTopOffset: 30 | ||
| * viewportTopOffset: 30, | ||
| * | ||
| * shouldGroupWhenFull: true |
There was a problem hiding this comment.
| * shouldGroupWhenFull: true | |
| * shouldGroupWhenFull: false |
No one will be setting it to true as this is the default.
There was a problem hiding this comment.
Actually, I'd rather rename it to shouldNotGroupWhenFull to avoid a flag which is default by true. Then you'll also have less issues with handling the default in the other two PRs.
oleq
changed the title
Suggested merge commit message (convention)
Docs: Added documentation for the
config.toolbar.shouldGroupWhenFulloption. Closes ckeditor/ckeditor5#5692.Additional information
Requires:
config.toolbar.shouldGroupWhenFullconfiguration ckeditor5-editor-classic#100config.toolbar.shouldGroupWhenFullconfiguration ckeditor5-editor-decoupled#45